* and the controller actions triggered.
*
* Returns: %TRUE if the event was potentially useful to trigger the
- * controller action.
+ * controller action
*
* Since: 3.14
**/
*
* Returns the event mask necessary for the events handled by @controller.
*
- * Returns: the controller event mask.
+ * Returns: the controller event mask
*
* Since: 3.14
**/
/**
* GtkGesture::end:
* @gesture: the object which received the signal
- * @sequence: the #GdkEventSequence that made gesture recognition to finish.
+ * @sequence: the #GdkEventSequence that made gesture recognition to finish
*
* This signal is emitted when @gesture either stopped recognizing the event
* sequences as something to be handled (the #GtkGesture::check handler returned
- * #FALSE), or the number of touch sequences became higher or lower than
+ * %FALSE), or the number of touch sequences became higher or lower than
* #GtkGesture:n-points.
*
* Note: @sequence might not pertain to the group of sequences that were
/**
* GtkGesture::update:
* @gesture: the object which received the signal
- * @sequence: the #GdkEventSequence that was updated.
+ * @sequence: the #GdkEventSequence that was updated
*
* This signal is emitted whenever an event is handled while the gesture is
* recognized. @sequence is guaranteed to pertain to the set of active touches.
/**
* GtkGesture::cancel:
* @gesture: the object which received the signal
- * @sequence: the #GdkEventSequence that was cancelled.
+ * @sequence: the #GdkEventSequence that was cancelled
*
* This signal is emitted whenever a sequence is cancelled. This usually
* happens on active touches when gtk_event_controller_reset() is called
/**
* GtkGesture::sequence-state-changed:
* @gesture: the object which received the signal
- * @sequence: the #GdkEventSequence that was cancelled.
+ * @sequence: the #GdkEventSequence that was cancelled
* @state: the new sequence state
*
* This signal is emitted whenever a sequence state changes. See
* Returns the master #GdkDevice that is currently operating
* on @gesture, or %NULL if the gesture is not being interacted.
*
- * Returns: a #GdkDevice, or %NULL.
+ * Returns: a #GdkDevice, or %NULL
*
* Since: 3.14
**/
*
* Returns the @sequence state, as seen by @gesture.
*
- * Returns: The sequence state in @gesture.
+ * Returns: The sequence state in @gesture
*
* Since: 3.14
**/
* * None → Claimed
* * None → Claimed → Denied
*
- * Returns: #TRUE if @sequence is handled by @gesture,
- * and the state is changed successfully.
+ * Returns: %TRUE if @sequence is handled by @gesture,
+ * and the state is changed successfully
*
* Since: 3.14
**/
* for more details on sequence states.
*
* Returns: %TRUE if the state of at least one sequence
- * was changed successfully.
+ * was changed successfully
*
* Since: 3.14
*/
* @gesture: a #GtkGesture
*
* Returns the list of #GdkEventSequences currently being interpreted
- * by @gesture
+ * by @gesture.
*
* Returns: (transfer container) (element-type GdkEventSequence): A list
* of #GdkEventSequences, the list elements are owned by GTK+
* and must not be freed or modified, the list itself must be deleted
* through g_list_free()
+ *
+ * Since: 3.14
**/
GList *
gtk_gesture_get_sequences (GtkGesture *gesture)
*
* Returns the #GdkEventSequence that was last updated on @gesture.
*
- * Returns: The last updated sequence.
+ * Returns: The last updated sequence
*
* Since: 3.14
**/
* @rect: (out): bounding box containing all active touches.
*
* If there are touch sequences being currently handled by @gesture,
- * this function returns #TRUE and fills in @rect with the bounding
- * box containing all active touches. Otherwise, #FALSE will be
+ * this function returns %TRUE and fills in @rect with the bounding
+ * box containing all active touches. Otherwise, %FALSE will be
* returned.
*
- * Returns: #TRUE if there are active touches, #FALSE otherwise
+ * Returns: %TRUE if there are active touches, %FALSE otherwise
*
* Since: 3.14
**/
* @y: (out): Y coordinate for the bounding box center
*
* If there are touch sequences being currently handled by @gesture,
- * this function returns #TRUE and fills in @x and @y with the center
- * of the bounding box containing all active touches. Otherwise, #FALSE
+ * this function returns %TRUE and fills in @x and @y with the center
+ * of the bounding box containing all active touches. Otherwise, %FALSE
* will be returned.
*
- * Returns: #FALSE if no active touches are present, #TRUE otherwise
+ * Returns: %FALSE if no active touches are present, %TRUE otherwise
*
* Since: 3.14
**/
* A gesture is active meanwhile there are touch sequences
* interacting with it.
*
- * Returns: %TRUE if gesture is active.
+ * Returns: %TRUE if gesture is active
*
* Since: 3.14
**/
* Returns %TRUE if the gesture is currently recognized.
* A gesture is recognized if there are as many interacting
* touch sequences as required by @gesture, and #GtkGesture::check
- * returned #TRUE for the sequences being currently interpreted.
+ * returned %TRUE for the sequences being currently interpreted.
*
- * Returns: %TRUE if gesture is recognized.
+ * Returns: %TRUE if gesture is recognized
*
* Since: 3.14
**/
* @gesture: a #GtkGesture
* @sequence: a #GdkEventSequence
*
- * Returns #TRUE if @gesture is currently handling events corresponding to
+ * Returns %TRUE if @gesture is currently handling events corresponding to
* @sequence.
*
- * Returns: #TRUE if @gesture is handling @sequence.
+ * Returns: %TRUE if @gesture is handling @sequence
*
* Since: 3.14
**/
* handled by @gesture. See gtk_gesture_set_window() for more
* information.
*
- * Returns: the user defined window, or %NULL if none.
+ * Returns: the user defined window, or %NULL if none
*
* Since: 3.14
**/
* Returns all gestures in the group of @gesture
*
* Returns: (element-type GtkGesture) (transfer container): The list
- * of #GtkGestures, free with g_list_free().
+ * of #GtkGestures, free with g_list_free()
*
* Since: 3.14
**/
* @gesture: a #GtkGesture
* @other: another #GtkGesture
*
- * Returns #TRUE if both gestures pertain to the same group.
+ * Returns %TRUE if both gestures pertain to the same group.
*
* Returns: whether the gestures are grouped
*
* gtk_gesture_drag_new:
* @widget: a #GtkWidget
*
- * Returns a newly created #GtkGesture that recognizes drags
+ * Returns a newly created #GtkGesture that recognizes drags.
*
* Returns: a newly created #GtkGestureDrag
*
* and fills in @x and @y with the drag start coordinates,
* in window-relative coordinates.
*
- * Returns: #TRUE if the gesture is active.
+ * Returns: %TRUE if the gesture is active
*
* Since: 3.14
**/
* fills in @x and @y with the coordinates of the current point,
* as an offset to the starting drag point.
*
- * Returns: #TRUE if the gesture is active.
+ * Returns: %TRUE if the gesture is active
*
* Since: 3.14
**/
* gtk_gesture_long_press_new:
* @widget: a #GtkWidget
*
- * Returns a newly created #GtkGesture that recognizes long presses
+ * Returns a newly created #GtkGesture that recognizes long presses.
*
* Returns: a newly created #GtkGestureLongPress
*
*
* #GtkGestureMultiPress is a #GtkGesture implementation able to recognize
* multiple clicks on a nearby zone, which can be listened for through the
- * #GtkGestureMultiPress::pressed signal. Whenever time or distance between clicks
- * exceed the GTK+ defaults, #GtkGestureMultiPress::stopped is emitted, and the
- * click counter is reset.
+ * #GtkGestureMultiPress::pressed signal. Whenever time or distance between
+ * clicks exceed the GTK+ defaults, #GtkGestureMultiPress::stopped is emitted,
+ * and the click counter is reset.
*
* Callers may also restrict the area that is considered valid for a >1
* touch/button press through gtk_gesture_multi_press_set_area(), so any
/**
* gtk_gesture_multi_press_set_area:
* @gesture: a #GtkGesture
- * @rect: (allow-none): rectangle to receive coordinates on.
+ * @rect: (allow-none): rectangle to receive coordinates on
*
- * If @rect is non-#NULL, the press area will be checked to be
+ * If @rect is non-%NULL, the press area will be checked to be
* confined within the rectangle, otherwise the button count
* will be reset so the press is seen as being the first one.
* If @rect is #NULL, the area will be reset to an unrestricted
* @rect: (out): return location for the press area
*
* If an area was set through gtk_gesture_multi_press_set_area(),
- * this function will return #TRUE and fill in @rect with the
+ * this function will return %TRUE and fill in @rect with the
* press area. See gtk_gesture_multi_press_set_area() for more
* details on what the press area represents.
*
- * Returns: 3.14
+ * Returns: %TRUE if @rect was filled with the press area
+ *
+ * Since: 3.14
**/
gboolean
gtk_gesture_multi_press_get_area (GtkGestureMultiPress *gesture,
*
* Returns the orientation of the pan gestures that this @gesture expects.
*
- * Return value: the expected orientation for pan gestures.
+ * Return value: the expected orientation for pan gestures
*
* Since: 3.14
*/
/**
* SECTION:gtkgesturesingle
- * @Short_description: Base class for for mouse/single-touch gestures
+ * @Short_description: Base class for for mouse/single-touch gestures
* @Title: GtkGestureSingle
*
* #GtkGestureSingle is a subclass of #GtkGesture, optimized (although
/**
* GtkGestureSingle:touch-only:
*
- * Whether the gesture handles only touch events
+ * Whether the gesture handles only touch events.
*
* Since: 3.14
*/
* gtk_gesture_single_get_touch_only:
* @gesture: a #GtkGestureSingle
*
- * Returns #TRUE if the gesture is only triggered by touch events.
+ * Returns %TRUE if the gesture is only triggered by touch events.
*
- * Returns: #TRUE if the gesture only handles touch events.
+ * Returns: %TRUE if the gesture only handles touch events
*
* Since: 3.14
**/
* @gesture: a #GtkGestureSingle
* @touch_only: whether @gesture handles only touch events
*
- * If @touch_only is #TRUE, @gesture will only handle events of type
- * #GDK_TOUCH_BEGIN, #GDK_TOUCH_UPDATE or #GDK_TOUCH_END. If #FALSE,
+ * If @touch_only is %TRUE, @gesture will only handle events of type
+ * #GDK_TOUCH_BEGIN, #GDK_TOUCH_UPDATE or #GDK_TOUCH_END. If %FALSE,
* mouse events will be handled too.
*
* Since: 3.14
/**
* gtk_gesture_single_set_exclusive:
* @gesture: a #GtkGestureSingle
- * @exclusive: #TRUE to make @gesture exclusive
+ * @exclusive: %TRUE to make @gesture exclusive
*
* Sets whether @gesture is exclusive. An exclusive gesture will
* only handle pointer and "pointer emulated" touch events, so at
* Returns the button number @gesture listens for, or 0 if @gesture
* reacts to any button press.
*
- * Returns: The button number, or 0 for any button.
+ * Returns: The button number, or 0 for any button
*
* Since: 3.14
**/
* is none.
*
* Returns: The current button number
+ *
+ * Since: 3.14
**/
guint
gtk_gesture_single_get_current_button (GtkGestureSingle *gesture)
* gtk_gesture_single_get_current_sequence:
* @gesture: a #GtkGestureSingle
*
- * Returns the event sequence currently interacting with @gesture,
- * this is only meaningful if gtk_gesture_is_active() returns #TRUE.
+ * Returns the event sequence currently interacting with @gesture.
+ * This is only meaningful if gtk_gesture_is_active() returns %TRUE.
*
* Returns: the current sequence
+ *
+ * Since: 3.14
**/
GdkEventSequence *
gtk_gesture_single_get_current_sequence (GtkGestureSingle *gesture)
*
* #GtkGestureSwipe is a #GtkGesture implementation able to recognize
* swipes, after a press/move/.../move/release sequence happens, the
- * GtkGestureSwipe:swipe signal will be emitted, providing the velocity
+ * #GtkGestureSwipe::swipe signal will be emitted, providing the velocity
* and directionality of the sequence at the time it was lifted.
*
* If the velocity is desired in intermediate points,
* gtk_gesture_swipe_get_velocity() can be called on eg. a
* #GtkGesture::update handler.
*
- * All velocities are reported in pixels/sec values.
+ * All velocities are reported in pixels/sec units.
*/
#include "config.h"
* gtk_gesture_swipe_new:
* @widget: a #GtkWidget
*
- * Returns a newly created #GtkGesture that recognizes swipes
+ * Returns a newly created #GtkGesture that recognizes swipes.
*
* Returns: a newly created #GtkGestureSwipe
*
* @widget: a #GtkWidget
*
* Returns a newly created #GtkGesture that recognizes zoom
- * in/out gestures (usually known as pinch/zoom)
+ * in/out gestures (usually known as pinch/zoom).
*
* Returns: a newly created #GtkGestureZoom
*
projects / gtk4.git / commitdiff